<!DOCTYPE html>
<html lang="English"
      data-content_root="../../../"
      x-data="{ darkMode: localStorage.getItem('darkMode') || localStorage.setItem('darkMode', 'system'), activeSection: '' }"
      x-init="$watch('darkMode', val => localStorage.setItem('darkMode', val))"
      class="scroll-smooth"
      :class="{'dark': darkMode === 'dark' || (darkMode === 'system' && window.matchMedia('(prefers-color-scheme: dark)').matches)}"
>
<head>
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta charset="utf-8" />
  <meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
  <meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />
  
    <title>isek.agent.memory | ISEK 0.1 documentation</title>
    <meta property="og:title" content="isek.agent.memory | ISEK 0.1 documentation" />
    <meta name="twitter:title" content="isek.agent.memory | ISEK 0.1 documentation" />
      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=e72c8e07" />
      <link rel="stylesheet" type="text/css" href="../../../_static/theme.css?v=42baaae4" />
        <link rel="search" title="Search" href="../../../search.html" />
        <link rel="index" title="Index" href="../../../genindex.html" />

    <script>
    <!-- Prevent Flash of wrong theme -->
      const userPreference = localStorage.getItem('darkMode');
      let mode;
      if (userPreference === 'dark' || window.matchMedia('(prefers-color-scheme: dark)').matches) {
        mode = 'dark';
        document.documentElement.classList.add('dark');
      } else {
        mode = 'light';
      }
      if (!userPreference) {localStorage.setItem('darkMode', mode)}
    </script>
</head>
  <body x-data="{ showSidebar: false, showScrollTop: false }" class="min-h-screen font-sans antialiased bg-background text-foreground" :class="{ 'overflow-hidden': showSidebar }">
    <div x-cloak x-show="showSidebar" class="fixed inset-0 z-50 overflow-hidden bg-background/80 backdrop-blur-sm md:hidden" @click.self="showSidebar = false"></div><div id="page" class="relative flex flex-col min-h-screen"><a href="#content" class="absolute top-0 left-0 z-[100] block bg-background p-4 text-xl transition -translate-x-full opacity-0 focus:translate-x-0 focus:opacity-100">
      Skip to content
    </a><header
  class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
    <div class="hidden mr-4 md:flex">
      <a href="../../../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">ISEK 0.1 documentation</span>
      </a></div><button
      class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
      type="button" @click="showSidebar = true">
      <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" aria-hidden="true"
        fill="currentColor">
        <path
          d="M152.587 825.087q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440Zm0-203.587q-19.152 0-32.326-13.174T107.087 576q0-19.152 13.174-32.326t32.326-13.174h320q19.152 0 32.326 13.174T518.087 576q0 19.152-13.174 32.326T472.587 621.5h-320Zm0-203.587q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440ZM708.913 576l112.174 112.174q12.674 12.674 12.674 31.826t-12.674 31.826Q808.413 764.5 789.261 764.5t-31.826-12.674l-144-144Q600 594.391 600 576t13.435-31.826l144-144q12.674-12.674 31.826-12.674t31.826 12.674q12.674 12.674 12.674 31.826t-12.674 31.826L708.913 576Z" />
      </svg>
      <span class="sr-only">Toggle navigation menu</span>
    </button>
    <div class="flex items-center justify-between flex-1 space-x-2 sm:space-x-4 md:justify-end">
      <div class="flex-1 w-full md:w-auto md:flex-none"><form id="searchbox"
      action="../../../search.html"
      method="get"
      class="relative flex items-center group"
      @keydown.k.window.meta="$refs.search.focus()">
  <input x-ref="search"
          name="q"
          id="search-input"
          type="search"
          aria-label="Search the docs"
          placeholder="Search ..."
          class="inline-flex items-center font-medium transition-colors bg-transparent focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 ring-offset-background border border-input hover:bg-accent focus:bg-accent hover:text-accent-foreground focus:text-accent-foreground hover:placeholder-accent-foreground py-2 px-4 relative h-9 w-full justify-start rounded-[0.5rem] text-sm text-muted-foreground sm:pr-12 md:w-40 lg:w-64" />
  <kbd class="pointer-events-none absolute right-1.5 top-2 hidden h-5 select-none text-muted-foreground items-center gap-1 rounded border border-border bg-muted px-1.5 font-mono text-[10px] font-medium opacity-100 sm:flex group-hover:bg-accent group-hover:text-accent-foreground">
    <span class="text-xs">⌘</span>
    K
  </kbd>
</form>
      </div>
      <nav class="flex items-center space-x-1">
        <button @click="darkMode = darkMode === 'light' ? 'dark' : 'light'"
          class="relative inline-flex items-center justify-center px-0 text-sm font-medium transition-colors rounded-md hover:bg-accent hover:text-accent-foreground h-9 w-9"
          type="button"
          aria-label="Color theme switcher">
          <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" fill="currentColor"
            class="absolute transition-all scale-100 rotate-0 dark:-rotate-90 dark:scale-0">
            <path
              d="M480 685q45.456 0 77.228-31.772Q589 621.456 589 576q0-45.456-31.772-77.228Q525.456 467 480 467q-45.456 0-77.228 31.772Q371 530.544 371 576q0 45.456 31.772 77.228Q434.544 685 480 685Zm0 91q-83 0-141.5-58.5T280 576q0-83 58.5-141.5T480 376q83 0 141.5 58.5T680 576q0 83-58.5 141.5T480 776ZM80 621.5q-19.152 0-32.326-13.174T34.5 576q0-19.152 13.174-32.326T80 530.5h80q19.152 0 32.326 13.174T205.5 576q0 19.152-13.174 32.326T160 621.5H80Zm720 0q-19.152 0-32.326-13.174T754.5 576q0-19.152 13.174-32.326T800 530.5h80q19.152 0 32.326 13.174T925.5 576q0 19.152-13.174 32.326T880 621.5h-80Zm-320-320q-19.152 0-32.326-13.174T434.5 256v-80q0-19.152 13.174-32.326T480 130.5q19.152 0 32.326 13.174T525.5 176v80q0 19.152-13.174 32.326T480 301.5Zm0 720q-19.152 0-32.326-13.17Q434.5 995.152 434.5 976v-80q0-19.152 13.174-32.326T480 850.5q19.152 0 32.326 13.174T525.5 896v80q0 19.152-13.174 32.33-13.174 13.17-32.326 13.17ZM222.174 382.065l-43-42Q165.5 327.391 166 308.239t13.174-33.065q13.435-13.674 32.587-13.674t32.065 13.674l42.239 43q12.674 13.435 12.555 31.706-.12 18.272-12.555 31.946-12.674 13.674-31.445 13.413-18.772-.261-32.446-13.174Zm494 494.761-42.239-43q-12.674-13.435-12.674-32.087t12.674-31.565Q686.609 756.5 705.38 757q18.772.5 32.446 13.174l43 41.761Q794.5 824.609 794 843.761t-13.174 33.065Q767.391 890.5 748.239 890.5t-32.065-13.674Zm-42-494.761Q660.5 369.391 661 350.62q.5-18.772 13.174-32.446l41.761-43Q728.609 261.5 747.761 262t33.065 13.174q13.674 13.435 13.674 32.587t-13.674 32.065l-43 42.239q-13.435 12.674-31.706 12.555-18.272-.12-31.946-12.555Zm-495 494.761Q165.5 863.391 165.5 844.239t13.674-32.065l43-42.239q13.435-12.674 32.087-12.674t31.565 12.674Q299.5 782.609 299 801.38q-.5 18.772-13.174 32.446l-41.761 43Q231.391 890.5 212.239 890t-33.065-13.174ZM480 576Z" />
          </svg>
          <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" fill="currentColor"
            class="absolute transition-all scale-0 rotate-90 dark:rotate-0 dark:scale-100">
            <path
              d="M480 936q-151 0-255.5-104.5T120 576q0-138 90-239.5T440 218q25-3 39 18t-1 44q-17 26-25.5 55t-8.5 61q0 90 63 153t153 63q31 0 61.5-9t54.5-25q21-14 43-1.5t19 39.5q-14 138-117.5 229T480 936Zm0-80q88 0 158-48.5T740 681q-20 5-40 8t-40 3q-123 0-209.5-86.5T364 396q0-20 3-40t8-40q-78 32-126.5 102T200 576q0 116 82 198t198 82Zm-10-270Z" />
          </svg>
        </button>
      </nav>
    </div>
  </div>
</header>

    <div class="flex-1"><div class="container flex-1 items-start md:grid md:grid-cols-[220px_minmax(0,1fr)] md:gap-6 lg:grid-cols-[240px_minmax(0,1fr)] lg:gap-10"><aside id="left-sidebar"
  class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
  :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">

    <a href="../../../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">ISEK 0.1 documentation</span>
    </a>

    <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
      <div class="overflow-y-auto h-full w-full relative pr-6"><nav class="table w-full min-w-full my-6 lg:my-8">
  <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/index.html">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../user_guide/concepts.html">Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user_guide/agents.html">Agents</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user_guide/configuration.html">Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../api/index.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../api/core.html">Core Components</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/agent.html">Agent Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/llm.html">Large Language Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/embedding.html">Embedding</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/node.html">Node</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/util.html">Util</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
</ul>

</nav>
      </div>
    </div>
    <button type="button" @click="showSidebar = false"
      class="absolute md:hidden right-4 top-4 rounded-sm opacity-70 transition-opacity hover:opacity-100">
      <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" fill="currentColor"
        stroke="none" class="h-4 w-4">
        <path
          d="M480 632 284 828q-11 11-28 11t-28-11q-11-11-11-28t11-28l196-196-196-196q-11-11-11-28t11-28q11-11 28-11t28 11l196 196 196-196q11-11 28-11t28 11q11 11 11 28t-11 28L536 576l196 196q11 11 11 28t-11 28q-11 11-28 11t-28-11L480 632Z" />
      </svg>
    </button>
  </aside>
        <main class="relative py-6 lg:gap-10 lg:py-8 xl:grid xl:grid-cols-[1fr_300px]">
<div class="w-full min-w-0 mx-auto">
<nav aria-label="breadcrumbs"
     class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
  <a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
     href="../../../index.html">
    <span class="hidden md:inline">ISEK 0.1 documentation</span>
    <svg xmlns="http://www.w3.org/2000/svg"
         height="18"
         width="18"
         viewBox="0 96 960 960"
         aria-label="Home"
         fill="currentColor"
         stroke="none"
         class="md:hidden">
      <path d="M240 856h120V616h240v240h120V496L480 316 240 496v360Zm-80 80V456l320-240 320 240v480H520V696h-80v240H160Zm320-350Z" />
    </svg>
  </a>
  
<div class="mr-1">/</div><a class="hover:text-foreground overflow-hidden text-ellipsis whitespace-nowrap"
       href="../../index.html">Module code</a>
    
<div class="mr-1">/</div><span aria-current="page"
        class="font-medium text-foreground overflow-hidden text-ellipsis whitespace-nowrap">isek.agent.memory</span>
</nav>

    <div id="content" role="main">
      <h1>Source code for isek.agent.memory</h1><div class="highlight"><pre>
<span></span><code><span id="line-1"><span class="kn">import</span><span class="w"> </span><span class="nn">datetime</span>
</span><span id="line-2"><span class="kn">import</span><span class="w"> </span><span class="nn">uuid</span>
</span><span id="line-3"><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">Union</span>
</span><span id="line-4"><span class="kn">from</span><span class="w"> </span><span class="nn">isek.util.logger</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span> <span class="c1"># Assuming logger has a standard logging interface</span>
</span><span id="line-5"><span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
</span><span id="line-6">
</span><span id="line-7"><span class="n">T</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;T&#39;</span><span class="p">)</span>
</span><span id="line-8">
<div class="viewcode-block" id="AgentMemory">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory">[docs]</a>
</span><span id="line-9"><span class="k">class</span><span class="w"> </span><span class="nc">AgentMemory</span><span class="p">:</span>
</span><span id="line-10"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-11"><span class="sd">    Manages the complete cognitive state of an agent.</span>
</span><span id="line-12">
</span><span id="line-13"><span class="sd">    This includes working memory for recent interactions, a long-term knowledge</span>
</span><span id="line-14"><span class="sd">    store, a queue for scheduled tasks, and internal state variables that</span>
</span><span id="line-15"><span class="sd">    track the agent&#39;s status and goals.</span>
</span><span id="line-16"><span class="sd">    &quot;&quot;&quot;</span>
</span><span id="line-17">    
</span><span id="line-18">    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="line-19"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-20"><span class="sd">        Initializes the agent&#39;s memory systems.</span>
</span><span id="line-21">
</span><span id="line-22"><span class="sd">        Sets up the core components:</span>
</span><span id="line-23"><span class="sd">        </span>
</span><span id="line-24"><span class="sd">        - ``state_variables``: A dictionary to store key-value pairs representing the agent&#39;s current state.</span>
</span><span id="line-25"><span class="sd">        - ``working_memory``: A list to store recent interactions or thoughts.</span>
</span><span id="line-26"><span class="sd">        - ``task_queue``: A dictionary to manage tasks, their status, and priority.</span>
</span><span id="line-27"><span class="sd">        - ``knowledge_store``: A dictionary to store learned information or facts.</span>
</span><span id="line-28"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-29">        <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span> <span class="c1"># Assuming logger is an instance of a logging object</span>
</span><span id="line-30">        
</span><span id="line-31">        <span class="c1"># Core memory components</span>
</span><span id="line-32">        <span class="bp">self</span><span class="o">.</span><span class="n">state_variables</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;is_registered&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s2">&quot;goal&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">}</span>
</span><span id="line-33">        <span class="bp">self</span><span class="o">.</span><span class="n">working_memory</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="line-34">        <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># task_id -&gt; task_details</span>
</span><span id="line-35">        <span class="bp">self</span><span class="o">.</span><span class="n">knowledge_store</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># knowledge_id -&gt; knowledge_details</span>
</span><span id="line-36">    
<div class="viewcode-block" id="AgentMemory.log_operation">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.log_operation">[docs]</a>
</span><span id="line-37">    <span class="k">def</span><span class="w"> </span><span class="nf">log_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">details</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="line-38"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-39"><span class="sd">        Logs a memory operation using the configured logger.</span>
</span><span id="line-40">
</span><span id="line-41"><span class="sd">        :param operation_name: The name of the memory operation performed (e.g., &quot;set_state_variable&quot;).</span>
</span><span id="line-42"><span class="sd">        :type operation_name: str</span>
</span><span id="line-43"><span class="sd">        :param details: Specific details about the operation (e.g., variable name and value).</span>
</span><span id="line-44"><span class="sd">        :type details: str</span>
</span><span id="line-45"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-46">        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">:</span>
</span><span id="line-47">            <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Memory: </span><span class="si">{</span><span class="n">operation_name</span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="n">details</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>

</span><span id="line-48">    
<div class="viewcode-block" id="AgentMemory.generate_timestamp">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.generate_timestamp">[docs]</a>
</span><span id="line-49">    <span class="k">def</span><span class="w"> </span><span class="nf">generate_timestamp</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-50"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-51"><span class="sd">        Generates a current timestamp string.</span>
</span><span id="line-52">
</span><span id="line-53"><span class="sd">        The format is &quot;YYYY-MM-DD HH:MM:SS&quot;.</span>
</span><span id="line-54">
</span><span id="line-55"><span class="sd">        :return: The current timestamp as a formatted string.</span>
</span><span id="line-56"><span class="sd">        :rtype: str</span>
</span><span id="line-57"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-58">        <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S&quot;</span><span class="p">)</span></div>

</span><span id="line-59">    
<div class="viewcode-block" id="AgentMemory.generate_unique_id">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.generate_unique_id">[docs]</a>
</span><span id="line-60">    <span class="k">def</span><span class="w"> </span><span class="nf">generate_unique_id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-61"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-62"><span class="sd">        Generates a short unique ID.</span>
</span><span id="line-63">
</span><span id="line-64"><span class="sd">        The ID is the first 8 characters of a UUID version 4.</span>
</span><span id="line-65">
</span><span id="line-66"><span class="sd">        :return: A unique 8-character string identifier.</span>
</span><span id="line-67"><span class="sd">        :rtype: str</span>
</span><span id="line-68"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-69">        <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())[:</span><span class="mi">8</span><span class="p">]</span></div>

</span><span id="line-70">    
</span><span id="line-71">    <span class="c1"># --- State variable methods ---</span>
<div class="viewcode-block" id="AgentMemory.set_state_variable">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.set_state_variable">[docs]</a>
</span><span id="line-72">    <span class="k">def</span><span class="w"> </span><span class="nf">set_state_variable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">variable_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-73"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-74"><span class="sd">        Sets or updates a state variable in the agent&#39;s memory.</span>
</span><span id="line-75">
</span><span id="line-76"><span class="sd">        :param variable_name: The name of the state variable to set or update.</span>
</span><span id="line-77"><span class="sd">        :type variable_name: str</span>
</span><span id="line-78"><span class="sd">        :param value: The new value for the state variable.</span>
</span><span id="line-79"><span class="sd">        :type value: typing.Any</span>
</span><span id="line-80"><span class="sd">        :return: A confirmation message indicating the variable was set.</span>
</span><span id="line-81"><span class="sd">        :rtype: str</span>
</span><span id="line-82"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-83">        <span class="bp">self</span><span class="o">.</span><span class="n">state_variables</span><span class="p">[</span><span class="n">variable_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
</span><span id="line-84">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;set_state_variable&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">variable_name</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-85">        <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;State variable &#39;</span><span class="si">{</span><span class="n">variable_name</span><span class="si">}</span><span class="s2">&#39; set to &#39;</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">&#39;&quot;</span></div>

</span><span id="line-86">    
<div class="viewcode-block" id="AgentMemory.get_state_variable">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.get_state_variable">[docs]</a>
</span><span id="line-87">    <span class="k">def</span><span class="w"> </span><span class="nf">get_state_variable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">variable_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">T</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">T</span><span class="p">]:</span>
</span><span id="line-88"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-89"><span class="sd">        Retrieves the value of a state variable.</span>
</span><span id="line-90">
</span><span id="line-91"><span class="sd">        :param variable_name: The name of the state variable to retrieve.</span>
</span><span id="line-92"><span class="sd">        :type variable_name: str</span>
</span><span id="line-93"><span class="sd">        :param default: The default value to return if the variable_name is not found.</span>
</span><span id="line-94"><span class="sd">                        Defaults to None.</span>
</span><span id="line-95"><span class="sd">        :type default: T</span>
</span><span id="line-96"><span class="sd">        :return: The value of the state variable, or the default value if not found.</span>
</span><span id="line-97"><span class="sd">        :rtype: typing.Union[typing.Any, T]</span>
</span><span id="line-98"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-99">        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">state_variables</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">variable_name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span></div>

</span><span id="line-100">    
<div class="viewcode-block" id="AgentMemory.get_all_state_variables">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.get_all_state_variables">[docs]</a>
</span><span id="line-101">    <span class="k">def</span><span class="w"> </span><span class="nf">get_all_state_variables</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
</span><span id="line-102"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-103"><span class="sd">        Retrieves all current state variables and their values.</span>
</span><span id="line-104">
</span><span id="line-105"><span class="sd">        :return: A dictionary containing all state variables.</span>
</span><span id="line-106"><span class="sd">        :rtype: typing.Dict[str, typing.Any]</span>
</span><span id="line-107"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-108">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;get_all_state_variables&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;count: </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">state_variables</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-109">        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">state_variables</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span></div>

</span><span id="line-110">    
</span><span id="line-111">    <span class="c1"># --- Working memory methods ---</span>
<div class="viewcode-block" id="AgentMemory.store_memory_item">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.store_memory_item">[docs]</a>
</span><span id="line-112">    <span class="k">def</span><span class="w"> </span><span class="nf">store_memory_item</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">content</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-113"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-114"><span class="sd">        Adds an item to the agent&#39;s working memory.</span>
</span><span id="line-115">
</span><span id="line-116"><span class="sd">        Working memory typically stores recent interactions or temporary thoughts.</span>
</span><span id="line-117">
</span><span id="line-118"><span class="sd">        :param content: The string content to store in working memory.</span>
</span><span id="line-119"><span class="sd">        :type content: str</span>
</span><span id="line-120"><span class="sd">        :return: A confirmation message.</span>
</span><span id="line-121"><span class="sd">        :rtype: str</span>
</span><span id="line-122"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-123">        <span class="bp">self</span><span class="o">.</span><span class="n">working_memory</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
</span><span id="line-124">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;store_memory_item&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;item: </span><span class="si">{</span><span class="n">content</span><span class="p">[:</span><span class="mi">50</span><span class="p">]</span><span class="si">}</span><span class="s2">...&quot;</span><span class="p">)</span> <span class="c1"># Log truncated content</span>
</span><span id="line-125">        <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Memory item stored&quot;</span></div>

</span><span id="line-126">    
<div class="viewcode-block" id="AgentMemory.get_recent_memory_items">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.get_recent_memory_items">[docs]</a>
</span><span id="line-127">    <span class="k">def</span><span class="w"> </span><span class="nf">get_recent_memory_items</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">4</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
</span><span id="line-128"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-129"><span class="sd">        Retrieves the most recent items from working memory.</span>
</span><span id="line-130">
</span><span id="line-131"><span class="sd">        :param count: The maximum number of recent items to retrieve. Defaults to 4.</span>
</span><span id="line-132"><span class="sd">        :type count: int</span>
</span><span id="line-133"><span class="sd">        :return: A list of the most recent memory items, up to `count`.</span>
</span><span id="line-134"><span class="sd">        :rtype: typing.List[str]</span>
</span><span id="line-135"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-136">        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">working_memory</span><span class="p">)</span> <span class="o">&gt;</span> <span class="n">count</span><span class="p">:</span>
</span><span id="line-137">            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">working_memory</span><span class="p">[</span><span class="o">-</span><span class="n">count</span><span class="p">:]</span>
</span><span id="line-138">        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">working_memory</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="c1"># Return a copy to prevent external modification</span></div>

</span><span id="line-139">    
</span><span id="line-140">    <span class="c1"># --- Task queue methods ---</span>
<div class="viewcode-block" id="AgentMemory.create_task">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.create_task">[docs]</a>
</span><span id="line-141">    <span class="k">def</span><span class="w"> </span><span class="nf">create_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task_description</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">priority</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-142"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-143"><span class="sd">        Creates a new task and adds it to the task queue.</span>
</span><span id="line-144">
</span><span id="line-145"><span class="sd">        Each task is assigned a unique ID and includes its description,</span>
</span><span id="line-146"><span class="sd">        creation timestamp, completion status, and priority.</span>
</span><span id="line-147">
</span><span id="line-148"><span class="sd">        :param task_description: A description of the task to be performed.</span>
</span><span id="line-149"><span class="sd">        :type task_description: str</span>
</span><span id="line-150"><span class="sd">        :param priority: The priority of the task (e.g., higher number for higher priority).</span>
</span><span id="line-151"><span class="sd">                         Defaults to 1.</span>
</span><span id="line-152"><span class="sd">        :type priority: int</span>
</span><span id="line-153"><span class="sd">        :return: The unique ID of the created task.</span>
</span><span id="line-154"><span class="sd">        :rtype: str</span>
</span><span id="line-155"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-156">        <span class="n">task_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_unique_id</span><span class="p">()</span>
</span><span id="line-157">        <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="p">[</span><span class="n">task_id</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
</span><span id="line-158">            <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="n">task_description</span><span class="p">,</span>
</span><span id="line-159">            <span class="s2">&quot;created_at&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_timestamp</span><span class="p">(),</span>
</span><span id="line-160">            <span class="s2">&quot;completed&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="line-161">            <span class="s2">&quot;priority&quot;</span><span class="p">:</span> <span class="n">priority</span>
</span><span id="line-162">        <span class="p">}</span>
</span><span id="line-163">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;create_task&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;id: </span><span class="si">{</span><span class="n">task_id</span><span class="si">}</span><span class="s2">, task: </span><span class="si">{</span><span class="n">task_description</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-164">        <span class="k">return</span> <span class="n">task_id</span></div>

</span><span id="line-165">    
<div class="viewcode-block" id="AgentMemory.mark_task_completed">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.mark_task_completed">[docs]</a>
</span><span id="line-166">    <span class="k">def</span><span class="w"> </span><span class="nf">mark_task_completed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
</span><span id="line-167"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-168"><span class="sd">        Marks a specified task in the queue as completed.</span>
</span><span id="line-169">
</span><span id="line-170"><span class="sd">        Sets the &#39;completed&#39; flag to True and records the completion timestamp.</span>
</span><span id="line-171">
</span><span id="line-172"><span class="sd">        :param task_id: The ID of the task to mark as completed.</span>
</span><span id="line-173"><span class="sd">        :type task_id: str</span>
</span><span id="line-174"><span class="sd">        :return: `True` if the task was found and marked completed, `False` otherwise.</span>
</span><span id="line-175"><span class="sd">        :rtype: bool</span>
</span><span id="line-176"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-177">        <span class="k">if</span> <span class="n">task_id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="p">:</span>
</span><span id="line-178">            <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="p">[</span><span class="n">task_id</span><span class="p">][</span><span class="s2">&quot;completed&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
</span><span id="line-179">            <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="p">[</span><span class="n">task_id</span><span class="p">][</span><span class="s2">&quot;completed_at&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_timestamp</span><span class="p">()</span>
</span><span id="line-180">            <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;mark_task_completed&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;id: </span><span class="si">{</span><span class="n">task_id</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-181">            <span class="k">return</span> <span class="kc">True</span>
</span><span id="line-182">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;mark_task_completed&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;Task ID not found: </span><span class="si">{</span><span class="n">task_id</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-183">        <span class="k">return</span> <span class="kc">False</span></div>

</span><span id="line-184">    
<div class="viewcode-block" id="AgentMemory.get_pending_tasks">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.get_pending_tasks">[docs]</a>
</span><span id="line-185">    <span class="k">def</span><span class="w"> </span><span class="nf">get_pending_tasks</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
</span><span id="line-186"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-187"><span class="sd">        Retrieves all tasks that are currently not marked as completed.</span>
</span><span id="line-188">
</span><span id="line-189"><span class="sd">        :return: A dictionary of pending tasks, where keys are task IDs and</span>
</span><span id="line-190"><span class="sd">                 values are dictionaries of task details.</span>
</span><span id="line-191"><span class="sd">        :rtype: typing.Dict[str, typing.Dict[str, typing.Any]]</span>
</span><span id="line-192"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-193">        <span class="n">pending</span> <span class="o">=</span> <span class="p">{</span>
</span><span id="line-194">            <span class="n">task_id</span><span class="p">:</span> <span class="n">task_info</span> <span class="k">for</span> <span class="n">task_id</span><span class="p">,</span> <span class="n">task_info</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> 
</span><span id="line-195">            <span class="k">if</span> <span class="ow">not</span> <span class="n">task_info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;completed&quot;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
</span><span id="line-196">        <span class="p">}</span>
</span><span id="line-197">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;get_pending_tasks&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;count: </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">pending</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-198">        <span class="k">return</span> <span class="n">pending</span></div>

</span><span id="line-199">    
<div class="viewcode-block" id="AgentMemory.get_all_tasks">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.get_all_tasks">[docs]</a>
</span><span id="line-200">    <span class="k">def</span><span class="w"> </span><span class="nf">get_all_tasks</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
</span><span id="line-201"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-202"><span class="sd">        Retrieves all tasks from the queue, both pending and completed.</span>
</span><span id="line-203">
</span><span id="line-204"><span class="sd">        :return: A dictionary of all tasks, where keys are task IDs and</span>
</span><span id="line-205"><span class="sd">                 values are dictionaries of task details.</span>
</span><span id="line-206"><span class="sd">        :rtype: typing.Dict[str, typing.Dict[str, typing.Any]]</span>
</span><span id="line-207"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-208">        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="c1"># Return a copy</span></div>

</span><span id="line-209">    
</span><span id="line-210">    <span class="c1"># --- Knowledge store methods ---</span>
<div class="viewcode-block" id="AgentMemory.store_knowledge">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.store_knowledge">[docs]</a>
</span><span id="line-211">    <span class="k">def</span><span class="w"> </span><span class="nf">store_knowledge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">content</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-212"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-213"><span class="sd">        Stores a piece of knowledge in the knowledge store.</span>
</span><span id="line-214">
</span><span id="line-215"><span class="sd">        Each knowledge item is associated with a topic and includes the content</span>
</span><span id="line-216"><span class="sd">        and a creation timestamp.</span>
</span><span id="line-217">
</span><span id="line-218"><span class="sd">        :param topic: The topic or title for the knowledge item.</span>
</span><span id="line-219"><span class="sd">        :type topic: str</span>
</span><span id="line-220"><span class="sd">        :param content: The actual content of the knowledge item.</span>
</span><span id="line-221"><span class="sd">        :type content: str</span>
</span><span id="line-222"><span class="sd">        :return: The unique ID of the stored knowledge item.</span>
</span><span id="line-223"><span class="sd">        :rtype: str</span>
</span><span id="line-224"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-225">        <span class="n">knowledge_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_unique_id</span><span class="p">()</span>
</span><span id="line-226">        <span class="bp">self</span><span class="o">.</span><span class="n">knowledge_store</span><span class="p">[</span><span class="n">knowledge_id</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
</span><span id="line-227">            <span class="s2">&quot;topic&quot;</span><span class="p">:</span> <span class="n">topic</span><span class="p">,</span>
</span><span id="line-228">            <span class="s2">&quot;content&quot;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
</span><span id="line-229">            <span class="s2">&quot;created_at&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_timestamp</span><span class="p">()</span>
</span><span id="line-230">        <span class="p">}</span>
</span><span id="line-231">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;store_knowledge&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;id: </span><span class="si">{</span><span class="n">knowledge_id</span><span class="si">}</span><span class="s2">, topic: </span><span class="si">{</span><span class="n">topic</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-232">        <span class="k">return</span> <span class="n">knowledge_id</span></div>

</span><span id="line-233">    
<div class="viewcode-block" id="AgentMemory.retrieve_knowledge">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.retrieve_knowledge">[docs]</a>
</span><span id="line-234">    <span class="k">def</span><span class="w"> </span><span class="nf">retrieve_knowledge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
</span><span id="line-235"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-236"><span class="sd">        Retrieves knowledge content associated with a specific topic.</span>
</span><span id="line-237">
</span><span id="line-238"><span class="sd">        Searches the existing knowledge store for an item matching the given topic.</span>
</span><span id="line-239">
</span><span id="line-240"><span class="sd">        .. note::</span>
</span><span id="line-241"><span class="sd">            The original docstring mentioned a `generator_func` parameter,</span>
</span><span id="line-242"><span class="sd">            which is not present in the method signature. This version reflects</span>
</span><span id="line-243"><span class="sd">            the current signature.</span>
</span><span id="line-244">
</span><span id="line-245"><span class="sd">        :param topic: The topic to retrieve knowledge about.</span>
</span><span id="line-246"><span class="sd">        :type topic: str</span>
</span><span id="line-247"><span class="sd">        :return: The content of the knowledge item if found, otherwise `None`.</span>
</span><span id="line-248"><span class="sd">        :rtype: typing.Optional[str]</span>
</span><span id="line-249"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-250">        <span class="c1"># Search existing knowledge</span>
</span><span id="line-251">        <span class="k">for</span> <span class="n">k_id</span><span class="p">,</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">knowledge_store</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> <span class="c1"># k_id is not used here, could be `_`</span>
</span><span id="line-252">            <span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;topic&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="n">topic</span><span class="p">:</span>
</span><span id="line-253">                <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;retrieve_knowledge&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;found - topic: </span><span class="si">{</span><span class="n">topic</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-254">                <span class="k">return</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;content&quot;</span><span class="p">]</span>
</span><span id="line-255">        
</span><span id="line-256">        <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;retrieve_knowledge&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;not found - topic: </span><span class="si">{</span><span class="n">topic</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-257">        <span class="k">return</span> <span class="kc">None</span></div>

</span><span id="line-258">    
<div class="viewcode-block" id="AgentMemory.get_all_knowledge_topics">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.get_all_knowledge_topics">[docs]</a>
</span><span id="line-259">    <span class="k">def</span><span class="w"> </span><span class="nf">get_all_knowledge_topics</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
</span><span id="line-260"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-261"><span class="sd">        Retrieves a list of all topics currently in the knowledge store.</span>
</span><span id="line-262">
</span><span id="line-263"><span class="sd">        :return: A list of all knowledge topics.</span>
</span><span id="line-264"><span class="sd">        :rtype: typing.List[str]</span>
</span><span id="line-265"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-266">        <span class="k">return</span> <span class="p">[</span><span class="n">item</span><span class="p">[</span><span class="s2">&quot;topic&quot;</span><span class="p">]</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">knowledge_store</span><span class="o">.</span><span class="n">values</span><span class="p">()]</span></div>

</span><span id="line-267">    
</span><span id="line-268">    <span class="c1"># --- Interaction Methods ---</span>
<div class="viewcode-block" id="AgentMemory.state_interaction">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.state_interaction">[docs]</a>
</span><span id="line-269">    <span class="k">def</span><span class="w"> </span><span class="nf">state_interaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-270"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-271"><span class="sd">        Manages interactions with the agent&#39;s state variables.</span>
</span><span id="line-272">
</span><span id="line-273"><span class="sd">        This method allows for updating, inserting (which is equivalent to updating),</span>
</span><span id="line-274"><span class="sd">        or fetching the agent&#39;s state.</span>
</span><span id="line-275">
</span><span id="line-276"><span class="sd">        :param action: The action to perform: &quot;update&quot;, &quot;insert&quot;, or &quot;fetch&quot;.</span>
</span><span id="line-277"><span class="sd">        :type action: str</span>
</span><span id="line-278"><span class="sd">        :param title: The name (key) of the state variable.</span>
</span><span id="line-279"><span class="sd">        :type title: str</span>
</span><span id="line-280"><span class="sd">        :param value: The value to set for the state variable (used for &quot;update&quot; and &quot;insert&quot;).</span>
</span><span id="line-281"><span class="sd">                      Ignored for &quot;fetch&quot;.</span>
</span><span id="line-282"><span class="sd">        :type value: typing.Any</span>
</span><span id="line-283"><span class="sd">        :return: A string confirming the action taken or providing the fetched state.</span>
</span><span id="line-284"><span class="sd">        :rtype: str</span>
</span><span id="line-285"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-286">        <span class="k">if</span> <span class="n">action</span> <span class="o">==</span> <span class="s2">&quot;update&quot;</span><span class="p">:</span>
</span><span id="line-287">            <span class="bp">self</span><span class="o">.</span><span class="n">set_state_variable</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
</span><span id="line-288">            <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;State updated with &#39;</span><span class="si">{</span><span class="n">title</span><span class="si">}</span><span class="s2">&#39; as &#39;</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
</span><span id="line-289">        <span class="k">elif</span> <span class="n">action</span> <span class="o">==</span> <span class="s2">&quot;insert&quot;</span><span class="p">:</span> <span class="c1"># Functionally same as update for a dict</span>
</span><span id="line-290">            <span class="bp">self</span><span class="o">.</span><span class="n">set_state_variable</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
</span><span id="line-291">            <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;State inserted with &#39;</span><span class="si">{</span><span class="n">title</span><span class="si">}</span><span class="s2">&#39; as &#39;</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
</span><span id="line-292">        <span class="k">elif</span> <span class="n">action</span> <span class="o">==</span> <span class="s2">&quot;fetch&quot;</span><span class="p">:</span>
</span><span id="line-293">            <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Your state is </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_all_state_variables</span><span class="p">())</span><span class="si">}</span><span class="s2">&quot;</span>
</span><span id="line-294">        <span class="k">else</span><span class="p">:</span>
</span><span id="line-295">            <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;state_interaction&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;Unknown action: </span><span class="si">{</span><span class="n">action</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-296">            <span class="k">return</span> <span class="s2">&quot;No action is taken for state interaction due to unknown action.&quot;</span></div>

</span><span id="line-297">        
<div class="viewcode-block" id="AgentMemory.knowledge_interaction">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.knowledge_interaction">[docs]</a>
</span><span id="line-298">    <span class="k">def</span><span class="w"> </span><span class="nf">knowledge_interaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">content</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-299">        <span class="c1">#TODO:</span>
</span><span id="line-300">        <span class="c1"># For &quot;insert&quot; action, the `topic` should ideally be extracted from the `content`</span>
</span><span id="line-301">        <span class="c1"># or provided as a separate parameter, rather than using `content` for both.</span>
</span><span id="line-302"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-303"><span class="sd">        Manages interactions with the agent&#39;s knowledge store.</span>
</span><span id="line-304">
</span><span id="line-305"><span class="sd">        Allows querying for existing knowledge or inserting new knowledge.</span>
</span><span id="line-306">
</span><span id="line-307">
</span><span id="line-308"><span class="sd">        :param action: The action to perform: &quot;query&quot; or &quot;insert&quot;.</span>
</span><span id="line-309"><span class="sd">        :type action: str</span>
</span><span id="line-310"><span class="sd">        :param content: For &quot;query&quot;, this is the topic to search for.</span>
</span><span id="line-311"><span class="sd">                        For &quot;insert&quot;, this is the content to store (also used as topic currently).</span>
</span><span id="line-312"><span class="sd">        :type content: str</span>
</span><span id="line-313"><span class="sd">        :return: A string confirming the action or the result of the query.</span>
</span><span id="line-314"><span class="sd">        :rtype: str</span>
</span><span id="line-315"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-316">        <span class="k">if</span> <span class="n">action</span> <span class="o">==</span> <span class="s2">&quot;query&quot;</span><span class="p">:</span>
</span><span id="line-317">           <span class="n">retrieved_knowledge</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">retrieve_knowledge</span><span class="p">(</span><span class="n">content</span><span class="p">)</span> <span class="c1"># `content` is treated as topic</span>
</span><span id="line-318">           <span class="k">if</span> <span class="n">retrieved_knowledge</span><span class="p">:</span>
</span><span id="line-319">               <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Knowledge found for &#39;</span><span class="si">{</span><span class="n">content</span><span class="si">}</span><span class="s2">&#39;: </span><span class="si">{</span><span class="n">retrieved_knowledge</span><span class="si">}</span><span class="s2">&quot;</span>
</span><span id="line-320">           <span class="k">else</span><span class="p">:</span>
</span><span id="line-321">               <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;No knowledge found for topic: &#39;</span><span class="si">{</span><span class="n">content</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
</span><span id="line-322">        <span class="k">elif</span> <span class="n">action</span> <span class="o">==</span> <span class="s2">&quot;insert&quot;</span><span class="p">:</span>
</span><span id="line-323">            <span class="c1"># TODO: topic should be extracted from the content</span>
</span><span id="line-324">            <span class="n">knowledge_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">store_knowledge</span><span class="p">(</span><span class="n">topic</span><span class="o">=</span><span class="n">content</span><span class="p">,</span> <span class="n">content</span><span class="o">=</span><span class="n">content</span><span class="p">)</span> <span class="c1"># Using content as topic</span>
</span><span id="line-325">            <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Knowledge &#39;</span><span class="si">{</span><span class="n">content</span><span class="p">[:</span><span class="mi">50</span><span class="p">]</span><span class="si">}</span><span class="s2">...&#39; inserted with ID </span><span class="si">{</span><span class="n">knowledge_id</span><span class="si">}</span><span class="s2"> (topic: &#39;</span><span class="si">{</span><span class="n">content</span><span class="p">[:</span><span class="mi">30</span><span class="p">]</span><span class="si">}</span><span class="s2">...&#39;)&quot;</span>
</span><span id="line-326">        <span class="k">else</span><span class="p">:</span>
</span><span id="line-327">            <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;knowledge_interaction&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;Unknown action: </span><span class="si">{</span><span class="n">action</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-328">            <span class="k">return</span> <span class="s2">&quot;No action is taken for knowledge interaction due to unknown action.&quot;</span></div>

</span><span id="line-329">        
<div class="viewcode-block" id="AgentMemory.scheduling">
<a class="viewcode-back" href="../../../api/agent.html#isek.agent.memory.AgentMemory.scheduling">[docs]</a>
</span><span id="line-330">    <span class="k">def</span><span class="w"> </span><span class="nf">scheduling</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">option</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">task</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">finished</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="line-331"><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="line-332"><span class="sd">        Manages the agent&#39;s task schedule.</span>
</span><span id="line-333">
</span><span id="line-334"><span class="sd">        Allows adding new tasks, marking tasks as complete, or fetching all tasks.</span>
</span><span id="line-335">
</span><span id="line-336"><span class="sd">        .. warning::</span>
</span><span id="line-337"><span class="sd">            The `finished` parameter is present in the signature but not currently used.</span>
</span><span id="line-338"><span class="sd">            In the &quot;complete&quot; option, `task_id` is used in the return message but refers to</span>
</span><span id="line-339"><span class="sd">            the local `id` parameter.</span>
</span><span id="line-340">
</span><span id="line-341"><span class="sd">        :param option: The scheduling action: &quot;add&quot;, &quot;complete&quot;, or &quot;fetch&quot;.</span>
</span><span id="line-342"><span class="sd">        :type option: str</span>
</span><span id="line-343"><span class="sd">        :param id: The ID of the task (used for &quot;complete&quot;). Defaults to None.</span>
</span><span id="line-344"><span class="sd">        :type id: typing.Optional[str]</span>
</span><span id="line-345"><span class="sd">        :param task: The description of the task (used for &quot;add&quot;). Defaults to None.</span>
</span><span id="line-346"><span class="sd">        :type task: typing.Optional[str]</span>
</span><span id="line-347"><span class="sd">        :param finished: This parameter is currently unused. Defaults to False.</span>
</span><span id="line-348"><span class="sd">        :type finished: bool</span>
</span><span id="line-349"><span class="sd">        :return: A string confirming the action or providing the fetched schedule.</span>
</span><span id="line-350"><span class="sd">        :rtype: str</span>
</span><span id="line-351"><span class="sd">        &quot;&quot;&quot;</span>
</span><span id="line-352">        <span class="k">if</span> <span class="n">option</span> <span class="o">==</span> <span class="s2">&quot;add&quot;</span><span class="p">:</span>
</span><span id="line-353">            <span class="k">if</span> <span class="n">task</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="line-354">                <span class="k">return</span> <span class="s2">&quot;Task description cannot be None for &#39;add&#39; option.&quot;</span>
</span><span id="line-355">            <span class="n">task_id_created</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span><span class="n">task</span><span class="p">)</span>
</span><span id="line-356">            <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Task &#39;</span><span class="si">{</span><span class="n">task</span><span class="si">}</span><span class="s2">&#39; added to your schedule. Task ID is </span><span class="si">{</span><span class="n">task_id_created</span><span class="si">}</span><span class="s2">.&quot;</span>
</span><span id="line-357">        
</span><span id="line-358">        <span class="k">elif</span> <span class="n">option</span> <span class="o">==</span> <span class="s2">&quot;complete&quot;</span><span class="p">:</span>
</span><span id="line-359">            <span class="k">if</span> <span class="nb">id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="line-360">                <span class="k">return</span> <span class="s2">&quot;Task ID cannot be None for &#39;complete&#39; option.&quot;</span>
</span><span id="line-361">            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">mark_task_completed</span><span class="p">(</span><span class="nb">id</span><span class="p">):</span>
</span><span id="line-362">                <span class="c1"># The original code used &#39;task_id&#39; here, which was not defined in this scope.</span>
</span><span id="line-363">                <span class="c1"># It should probably refer to &#39;id&#39; or fetch the task description.</span>
</span><span id="line-364">                <span class="c1"># For now, let&#39;s use &#39;id&#39; as the identifier.</span>
</span><span id="line-365">                <span class="n">task_description</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;description&quot;</span><span class="p">,</span> <span class="s2">&quot;Unknown task&quot;</span><span class="p">)</span>
</span><span id="line-366">                <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Task &#39;</span><span class="si">{</span><span class="n">task_description</span><span class="si">}</span><span class="s2">&#39; (ID: </span><span class="si">{</span><span class="nb">id</span><span class="si">}</span><span class="s2">) marked as completed in your schedule.&quot;</span>
</span><span id="line-367">            <span class="k">else</span><span class="p">:</span>
</span><span id="line-368">                <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Failed to mark task with ID &#39;</span><span class="si">{</span><span class="nb">id</span><span class="si">}</span><span class="s2">&#39; as completed (task not found).&quot;</span>
</span><span id="line-369">        
</span><span id="line-370">        <span class="k">elif</span> <span class="n">option</span> <span class="o">==</span> <span class="s2">&quot;fetch&quot;</span><span class="p">:</span>
</span><span id="line-371">            <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Your schedule is </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_all_tasks</span><span class="p">())</span><span class="si">}</span><span class="s2">&quot;</span>
</span><span id="line-372">        <span class="k">else</span><span class="p">:</span>
</span><span id="line-373">            <span class="bp">self</span><span class="o">.</span><span class="n">log_operation</span><span class="p">(</span><span class="s2">&quot;scheduling&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;Unknown option: </span><span class="si">{</span><span class="n">option</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</span><span id="line-374">            <span class="k">return</span> <span class="s2">&quot;No action is taken for scheduling due to unknown option.&quot;</span></div>
</div>

</span></code></pre></div>
    </div></div>
        </main>
      </div>
    </div><footer class="py-6 border-t border-border md:py-0">
    <div class="container flex flex-col items-center justify-between gap-4 md:h-24 md:flex-row">
      <div class="flex flex-col items-center gap-4 px-8 md:flex-row md:gap-2 md:px-0">
        <p class="text-sm leading-loose text-center text-muted-foreground md:text-left">© 2025, ISEK Team&nbsp;Built with <a class="font-medium underline underline-offset-4"
    href="https://www.sphinx-doc.org"
    rel="noreferrer">Sphinx 8.1.3</a></p>
</div>
</div>
</footer>
  </div>
  
    <script src="../../../_static/documentation_options.js?v=2ed17a75"></script>
    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script defer="defer" src="../../../_static/theme.js?v=073f68d9"></script>
  
</body>
</html>